Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added missing step from multi tentant example quick start #10362

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

michaelparkadze
Copy link

Following the README.md of the multi tenant example, I tried to run the project and got an error of a missing secret key. I didn't understand instantly that its because I didn't setup the .env file so I thought it would be a good addition to the documentation.

Additionaly minor "beautification" of the quick start section.

Before (screenshot):
before

After (screenshot):
after

@michaelparkadze michaelparkadze changed the title chore(documentation): added missing step from multi tentant example quick start docs: added missing step from multi tentant example quick start Jan 5, 2025
Duplicate the .env.example file and rename it to .env.


```bash
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to document the contents of .env.example, as the user will already have them once they copy .env.example to .env

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AlessioGr I agree, I looked at the other README files of the other examples, they include the cp command example for this part. Let me know if this way is better.

replaced the contents of the .env file with the cp command example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants